/**
 * This file is part of AppStoreBot.
 *
 * AppStoreBot is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * AppStoreBot is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with AppStoreBot.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
package lu.pragmaconsult.appstorebot;

/**
 * 
 * Define a bot that is in charge of going through the web site to the report
 * files containing statistics. It must follow the way the {@link BotContext} is
 * configure.
 * 
 * @author Wilfried Vandenberghe (wilfried.vandenberghe at pragmaconsult.lu)
 */
public interface Bot {

	/**
	 * Set the execution context of this bot.
	 * 
	 * @param context
	 *            contains settings that are used for bot behavior
	 * @return this bot
	 * @throws IllegalArgumentException
	 *             thrown when a context argument is not valid
	 */
	Bot configure(BotContext context) throws IllegalArgumentException;

	/**
	 * Executes this bot.
	 * 
	 * @return exit status
	 */
	ExitStatus run();
}
